Skip to content

docs: add forking OpenROAD instructions to Git Guide and README#3901

Open
YadavAkhileshh wants to merge 1 commit into
The-OpenROAD-Project:masterfrom
YadavAkhileshh:fix/gitguide-forking-openroad
Open

docs: add forking OpenROAD instructions to Git Guide and README#3901
YadavAkhileshh wants to merge 1 commit into
The-OpenROAD-Project:masterfrom
YadavAkhileshh:fix/gitguide-forking-openroad

Conversation

@YadavAkhileshh
Copy link
Copy Markdown

Fixes #2213

OpenROAD is a Git submodule inside ORFS at tools/OpenROAD/. When contributors fork only ORFS, the submodule still points to
the original OpenROAD repo. Since they lack write access to the original, the build fails.

Changes:

  • docs/contrib/GitGuide.md: Added step-by-step forking instructions
  • README.md: Added a note directing contributors to the Git Guide

Signed-off-by: YadavAkhileshh <yadavakhil2501@gmail.com>
@maliberty maliberty requested a review from vvbandeira February 20, 2026 16:59
Comment thread docs/contrib/GitGuide.md
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file gets overwritten by docs/conf.py and we use the one from OR as the base. Changes should be made after the file is fetched.

@github-actions
Copy link
Copy Markdown
Contributor

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 21 days if no further activity occurs. Remove the Stale label or comment to keep it open.

@github-actions github-actions Bot added the Stale label May 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ORFS Git Guide should mention forking OR

2 participants